API Documentation
FileExplorer.h
1 // FileExplorer.h
3 //
5 
6 namespace nkWinUi
7 {
11  class DLL_WINUI_EXPORT FileExplorer : public Component
12  {
13  public :
14 
18  class FileFilter
19  {
20  public :
21 
22 
23  std::string _label ;
24  std::string _extension ;
25 
35  FileFilter (const FileFilter& other) ;
40  } ;
41 
42  public :
43 
52 
59  void addFilter (const std::string_view& label, const std::string_view& extension) ;
66  FileFilter& getFilter (unsigned int index) ;
74  void setFilter (unsigned int index, const std::string_view& label, const std::string_view& extension) ;
75 
81  void setFollowSelfDir (bool value) ;
85  bool getFollowSelfDir () const ;
91  void setCurrentDir (const std::string_view& path) ;
95  const char* getCurrentDir () const ;
96 
103  virtual std::string openDialog (bool forSave) = 0 ;
104 
108  virtual void exportIntrospection (nkExport::Node* rootNode) override ;
112  virtual void importClassFromTree (nkExport::Node* rootNode) override ;
113  } ;
114 }
nkWinUi::FileExplorer::getFollowSelfDir
bool getFollowSelfDir() const
nkWinUi::FileExplorer::FileFilter::_extension
std::string _extension
The extensions filtered by the filter.
Definition: FileExplorer.h:24
nkWinUi::FileExplorer::setCurrentDir
void setCurrentDir(const std::string_view &path)
nkWinUi::FileExplorer::FileFilter::_label
std::string _label
The label shown for the filter in the interface.
Definition: FileExplorer.h:23
nkWinUi::FileExplorer::exportIntrospection
virtual void exportIntrospection(nkExport::Node *rootNode) override
nkWinUi::FileExplorer::openDialog
virtual std::string openDialog(bool forSave)=0
nkWinUi::FileExplorer::FileFilter::~FileFilter
~FileFilter()
nkWinUi::FileExplorer::FileFilter::FileFilter
FileFilter()
nkWinUi::FileExplorer::FileFilter
Used to filter files in the interface.
Definition: FileExplorer.h:19
nkWinUi::Component
Base class for any graphical component.
Definition: Component.h:12
nkWinUi::FileExplorer::getFilter
FileFilter & getFilter(unsigned int index)
nkWinUi::FileExplorer
A graphical file explorer.
Definition: FileExplorer.h:12
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkWinUi::FileExplorer::FileExplorer
FileExplorer()
nkWinUi::FileExplorer::addFilter
void addFilter(const std::string_view &label, const std::string_view &extension)
nkWinUi::FileExplorer::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode) override
nkWinUi::FileExplorer::setFilter
void setFilter(unsigned int index, const std::string_view &label, const std::string_view &extension)
nkWinUi::FileExplorer::getCurrentDir
const char * getCurrentDir() const
nkWinUi::FileExplorer::~FileExplorer
~FileExplorer()
nkWinUi::FileExplorer::setFollowSelfDir
void setFollowSelfDir(bool value)
nkWinUi
Encompasses all API of component NilkinsWinUi.
Definition: Button.h:7
nkWinUi::FileExplorer::FileFilter::FileFilter
FileFilter(const FileFilter &other)